STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

M.?? StructureDefinition: Consent Directive

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/consentdirective

Consent Directive

This profile was published on [no date] with unknown status '" by .

M.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Contract.

Summary

Mandatory: 0 element (+11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractConsent Directive
... identifier ∑0..1IdentifierConsent Directive identifier
... issued ∑0..1dateTimeWhen this Consent Directive was issued
... applies ∑0..1PeriodEffective time
... topic ∑1..1Reference(Patient)The Patient is the topic of this Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type ∑1..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType ∑0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... valuedItem 0..0
... signer 0..*BackboneElementConsent Directive Signer
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization | Patient | Practitioner | RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... identifier ∑0..1IdentifierConsent Directive Term identifier
.... issued ∑0..1dateTimeConsent Directive Term Issue Date Time
.... applies ∑0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Type Codes (example)
.... topic 0..*Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... valuedItem 0..0
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractConsent Directive
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..1IdentifierConsent Directive identifier
... issued ∑0..1dateTimeWhen this Consent Directive was issued
... applies ∑0..1PeriodEffective time
... subject ∑0..*Reference(Resource)Patient who is the subject of this Privacy Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type ∑0..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType ∑0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... signer 0..*BackboneElementConsent Directive Signer
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization | Patient | Practitioner | RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierConsent Directive Term identifier
.... issued ∑0..1dateTimeConsent Directive Term Issue Date Time
.... applies ∑0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Type Codes (example)
.... topic 0..1Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format

todo

This structure is derived from Contract.

Summary

Mandatory: 0 element (+11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

Differential View

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractConsent Directive
... identifier ∑0..1IdentifierConsent Directive identifier
... issued ∑0..1dateTimeWhen this Consent Directive was issued
... applies ∑0..1PeriodEffective time
... topic ∑1..1Reference(Patient)The Patient is the topic of this Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type ∑1..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType ∑0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... valuedItem 0..0
... signer 0..*BackboneElementConsent Directive Signer
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization | Patient | Practitioner | RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... identifier ∑0..1IdentifierConsent Directive Term identifier
.... issued ∑0..1dateTimeConsent Directive Term Issue Date Time
.... applies ∑0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Type Codes (example)
.... topic 0..*Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... valuedItem 0..0
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*ContractConsent Directive
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ∑0..1IdentifierConsent Directive identifier
... issued ∑0..1dateTimeWhen this Consent Directive was issued
... applies ∑0..1PeriodEffective time
... subject ∑0..*Reference(Resource)Patient who is the subject of this Privacy Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type ∑0..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType ∑0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... signer 0..*BackboneElementConsent Directive Signer
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization | Patient | Practitioner | RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier ∑0..1IdentifierConsent Directive Term identifier
.... issued ∑0..1dateTimeConsent Directive Term Issue Date Time
.... applies ∑0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Type Codes (example)
.... topic 0..1Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... entity 1..1Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

M.??.2 Terminology Bindings

PathNameConformanceValueSet
Contract.language?extrequiredhttp://tools.ietf.org/html/bcp47
Contract.typeContract Type CodesexampleContract Type Codes
Contract.subTypeContract Subtype CodesexampleContract Subtype Codes
Contract.actionContract Action CodesexampleContract Action Codes
Contract.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.actor.roleContract Actor Role CodesexampleContract Actor Role Codes
Contract.signer.typeContract Signer Type CodespreferredContract Signer Type Codes
Contract.term.typeContract Term Type CodesexampleContract Term Type Codes
Contract.term.subTypeContract Term Type CodesexampleContract Term Type Codes
Contract.term.actionContract Action CodesexampleContract Action Codes
Contract.term.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.term.actor.roleContract Actor Role CodesexampleContract Actor Role Codes

M.??.3 Constraints

IdPathDetailsRequirements
qty-3Contract.valuedItem.quantityIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Contract.valuedItem.quantityThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
qty-3Contract.valuedItem.unitPriceIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
mny-1Contract.valuedItem.unitPriceThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
XPath: (f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='urn:iso:std:iso:4217')
qty-3Contract.valuedItem.netIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
mny-1Contract.valuedItem.netThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
XPath: (f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='urn:iso:std:iso:4217')
qty-3Contract.term.valuedItem.quantityIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Contract.term.valuedItem.quantityThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
qty-3Contract.term.valuedItem.unitPriceIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
mny-1Contract.term.valuedItem.unitPriceThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
XPath: (f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='urn:iso:std:iso:4217')
qty-3Contract.term.valuedItem.netIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
mny-1Contract.term.valuedItem.netThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
XPath: (f:code or not(f:value)) and (not(exists(f:system)) or f:system/@value='urn:iso:std:iso:4217')
.